/*
 * $Header: /home/cvs/jakarta-tomcat-4.0/webapps/admin/WEB-INF/classes/org/apache/webapp/admin/users/UserUtils.java,v 1.1 2002/02/10 08:06:20 craigmcc Exp $
 * $Revision: 1.1 $
 * $Date: 2002/02/10 08:06:20 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */


package org.apache.webapp.admin.users;


import java.util.Arrays;
import javax.management.MBeanServer;
import javax.management.ObjectName;


/**
 * <p>Shared utility methods for the user database administration module.</p>
 *
 * @author Craig R. McClanahan
 * @version $Revision: 1.1 $ $Date: 2002/02/10 08:06:20 $
 * @since 4.1
 */

public class UserUtils {


    // --------------------------------------------------------- Public Methods


    /**
     * Construct and return a GroupsForm identifying all currently defined
     * groups in the specified user database.
     *
     * @param mserver MBeanServer to be consulted
     * @param databaseName MBean Name of the user database to be consulted
     *
     * @exception Exception if an error occurs
     */
    public static GroupsForm getGroupsForm(MBeanServer mserver,
                                           String databaseName)
        throws Exception {

        ObjectName dname = new ObjectName(databaseName);
        String results[] =
            (String[]) mserver.getAttribute(dname, "groups");
        if (results == null) {
            results = new String[0];
        }
        Arrays.sort(results);

        GroupsForm groupsForm = new GroupsForm();
        groupsForm.setDatabaseName(databaseName);
        groupsForm.setGroups(results);
        return (groupsForm);

    }


    /**
     * Construct and return a RolesForm identifying all currently defined
     * roles in the specified user database.
     *
     * @param mserver MBeanServer to be consulted
     * @param databaseName MBean Name of the user database to be consulted
     *
     * @exception Exception if an error occurs
     */
    public static RolesForm getRolesForm(MBeanServer mserver,
                                           String databaseName)
        throws Exception {

        ObjectName dname = new ObjectName(databaseName);
        String results[] =
            (String[]) mserver.getAttribute(dname, "roles");
        if (results == null) {
            results = new String[0];
        }
        Arrays.sort(results);

        RolesForm rolesForm = new RolesForm();
        rolesForm.setDatabaseName(databaseName);
        rolesForm.setRoles(results);
        return (rolesForm);

    }


    /**
     * Construct and return a UsersForm identifying all currently defined
     * users in the specified user database.
     *
     * @param mserver MBeanServer to be consulted
     * @param databaseName MBean Name of the user database to be consulted
     *
     * @exception Exception if an error occurs
     */
    public static UsersForm getUsersForm(MBeanServer mserver,
                                           String databaseName)
        throws Exception {

        ObjectName dname = new ObjectName(databaseName);
        String results[] =
            (String[]) mserver.getAttribute(dname, "users");
        if (results == null) {
            results = new String[0];
        }
        Arrays.sort(results);

        UsersForm usersForm = new UsersForm();
        usersForm.setDatabaseName(databaseName);
        usersForm.setUsers(results);
        return (usersForm);

    }


}
